Restrict some types in object initializer setters when not directly settable #75507
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
dotnet-issue-labeler
bot
added
Area-IDE
untriaged
dotnet-policy-service
bot
added
Community
|
@CyrusNajmabadi ptal, let me know if the approach is appropriate |
| switch (type.SpecialType) | ||
| { | ||
| // While it is perfectly legal to assign instances of all these types to `{}`, | ||
| // it has no effects and is thus a needless recommendation |
There was a problem hiding this comment.
i don't understand this comment.
There was a problem hiding this comment.
I mean assignments of the form Property = {} in the object initializer. Example of such a legal case:
class C
{
string S { get; }
}
new C()
{
S = {},
};| switch (definition.SpecialType) | ||
| { | ||
| case SpecialType.System_Collections_Generic_IEnumerable_T: | ||
| case SpecialType.System_Collections_Generic_IEnumerator_T: |
There was a problem hiding this comment.
these need explanations.
| return !type.IsDelegateType() | ||
| && !type.IsStructType() | ||
| && !type.IsFunctionPointerType() | ||
| && type.TypeKind != TypeKind.Pointer; |
There was a problem hiding this comment.
these need explanations.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This is a limited yet largely effective solution to #74331
Implementation details
When the property or field is not directly settable, we do not recommend the member as settable if any of the following is met:
Object,String,Enum,Array,Delegate,MulticastDelegate,IEnumerableandIEnumeratorIEnumerable<T>orIEnumerator<T>The above types have no settable members within an object initializer and cannot make use of a collection initializer. The only legal syntax they can have is
X = { }which is a no-op setter, and since it's more of a trick than is being actually used, we do not offer the user the recommendation. They are still free to use the unrecommended members in the initializer, but only being able to "assign"{ }as shown above.We only filter
Arrayitself because it does not support indexing. Array types with a concrete rank can be indexed within the initializer like so:Limitations
This is limited to just the known types as specified above. Other types that could be filtered out with the same properties, which would require traversing their members on-demand. This is a risky option because of the performance implications that could heavily affect the performance of the recommendation service which is intended to operate in real-time. It would be nice to have, but my personal view on solving that leans towards a cached value showing whether the type symbol can support object or collection initializers, being synchronized as the compilation is updated. Such a system would be very complicated and is not taken yet into consideration.